<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template zip</title>
<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Boost.Test">
<link rel="up" href="../../../../header/boost/test/data/monomorphic/zip_hpp.html" title="Header &lt;boost/test/data/monomorphic/zip.hpp&gt;">
<link rel="prev" href="is_datas_idm44970734867312.html" title="Struct template is_dataset&lt;zip&lt; DataSet1, DataSet2 &gt;&gt;">
<link rel="next" href="zip/iterator.html" title="Struct iterator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_datas_idm44970734867312.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../header/boost/test/data/monomorphic/zip_hpp.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="zip/iterator.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.unit_test.data.monomorphic.zip"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template zip</span></h2>
<p>boost::unit_test::data::monomorphic::zip — Zip datasets. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../../header/boost/test/data/monomorphic/zip_hpp.html" title="Header &lt;boost/test/data/monomorphic/zip.hpp&gt;">boost/test/data/monomorphic/zip.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> DataSet1<span class="special">,</span> <span class="keyword">typename</span> DataSet2<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="zip.html" title="Class template zip">zip</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// member classes/structs/unions</span>

  <span class="keyword">struct</span> <a class="link" href="zip/iterator.html" title="Struct iterator">iterator</a> <span class="special">{</span>
    <span class="comment">// types</span>
    <span class="keyword">typedef</span> <span class="keyword">decltype</span><span class="special">(</span><span class="identifier">sample_merge</span><span class="special">(</span><span class="special">*</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special">&lt;</span> <span class="identifier">dataset1_iter</span> <span class="special">&gt;</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="special">*</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special">&lt;</span> <span class="identifier">dataset2_iter</span> <span class="special">&gt;</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">)</span> <a class="link" href="zip/iterator.html#boost.unit_test.data.monomorphic.zip.iterator.iterator_sample"><span class="identifier">iterator_sample</span></a><span class="special">;</span>

    <span class="comment">// <a class="link" href="zip/iterator.html#boost.unit_test.data.monomorphic.zip.iteratorconstruct-copy-destruct">construct/copy/destruct</a></span>
    <span class="keyword">explicit</span> <a class="link" href="zip/iterator.html#idm44970734856832-bb"><span class="identifier">iterator</span></a><span class="special">(</span><span class="identifier">dataset1_iter</span><span class="special">,</span> <span class="identifier">dataset2_iter</span><span class="special">)</span><span class="special">;</span>

    <span class="comment">// <a class="link" href="zip/iterator.html#idm44970734859520-bb">public member functions</a></span>
    <span class="keyword">auto</span> <a class="link" href="zip/iterator.html#idm44970734858960-bb"><span class="keyword">operator</span> <span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    <span class="keyword">void</span> <a class="link" href="zip/iterator.html#idm44970734857840-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="special">}</span><span class="special">;</span>

  <span class="keyword">enum</span> <a name="boost.unit_test.data.monomorphic.zip.@12"></a>@12 <span class="special">{</span> arity = = dataset1_decay::arity + dataset2_decay::arity <span class="special">}</span><span class="special">;</span>
  <span class="comment">// <a class="link" href="zip.html#boost.unit_test.data.monomorphic.zipconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="zip.html#idm44970734850400-bb"><span class="identifier">zip</span></a><span class="special">(</span><span class="identifier">DataSet1</span> <span class="special">&amp;&amp;</span><span class="special">,</span> <span class="identifier">DataSet2</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="zip.html#idm44970734848016-bb"><span class="identifier">zip</span></a><span class="special">(</span><a class="link" href="zip.html" title="Class template zip">zip</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="zip.html#idm44970734853616-bb">public member functions</a></span>
  <a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a class="link" href="zip.html#idm44970734853056-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <a class="link" href="zip/iterator.html" title="Struct iterator">iterator</a> <a class="link" href="zip.html#idm44970734851808-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="zip.html#idm44970734846464-bb">private member functions</a></span>
  <a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a class="link" href="zip.html#idm44970734845888-bb"><span class="identifier">zip_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idm45283075318880"></a><h2>Description</h2>
<p>A zip of two datasets is a dataset whose arity is the sum of the operand datasets arity. The size is given by the function creating the instance (see <code class="computeroutput">operator^</code> on datasets). </p>
<div class="refsect2">
<a name="idm45283075317328"></a><h3>
<a name="boost.unit_test.data.monomorphic.zipconstruct-copy-destruct"></a><code class="computeroutput">zip</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idm44970734850400-bb"></a><span class="identifier">zip</span><span class="special">(</span><span class="identifier">DataSet1</span> <span class="special">&amp;&amp;</span> ds1<span class="special">,</span> <span class="identifier">DataSet2</span> <span class="special">&amp;&amp;</span> ds2<span class="special">)</span><span class="special">;</span></pre>Constructor. <p>The datasets are moved and not copied. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idm44970734848016-bb"></a><span class="identifier">zip</span><span class="special">(</span><a class="link" href="zip.html" title="Class template zip">zip</a> <span class="special">&amp;&amp;</span> j<span class="special">)</span><span class="special">;</span></pre>Move constructor. </li>
</ol></div>
</div>
<div class="refsect2">
<a name="idm45283075302192"></a><h3>
<a name="idm44970734853616-bb"></a><code class="computeroutput">zip</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a name="idm44970734853056-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a class="link" href="zip/iterator.html" title="Struct iterator">iterator</a> <a name="idm44970734851808-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="idm45283075289776"></a><h3>
<a name="idm44970734846464-bb"></a><code class="computeroutput">zip</code> private member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a name="idm44970734845888-bb"></a><span class="identifier">zip_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Handles the sise of the resulting zipped dataset. </li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_datas_idm44970734867312.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../header/boost/test/data/monomorphic/zip_hpp.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="zip/iterator.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
